home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / cat2d200.zip / CAT2DIR.DOC next >
Text File  |  1992-09-07  |  6KB  |  126 lines
  1.                                 CAT2DIR.EXE
  2.                 CATDISK to PCBOARD File Directory Converter
  3.                        Version 2.00, September 7, 1992
  4.                             By K. Scott Johnson
  5.  
  6.  
  7. WHAT THE HELL IS IT?
  8.  
  9. CAT2DIR is a very simple program designed to fill a very simple need.
  10. Rey Barry, maintainer of the Freeware Hall of Fame and SYSOP of a BBS
  11. supporting that project, expressed the need for a program to help him
  12. keep track of offline files.  Files maintained offline weren't listed
  13. in the PCBoard directories of his BBS, and therefore were being sent
  14. up again by unknowing users.
  15.  
  16. Since the offline directories were maintained by the shareware program
  17. CATDISK, all that was needed was a way to convert these databases to the
  18. text format required by PCBoard, and to create the zero-byte file
  19. directory entries needed to block uploads.  CAT2DIR does this, and does
  20. it quickly and elegantly.
  21.  
  22. Since PCBoard file directories generally should contain archive files
  23. only, CAT2DIR will filter any non-archive entries from the output
  24. stream.  This means that you can continue to maintain complete CATDISK
  25. databases, with 'look into archives' turned on, without worrying about
  26. the individual file entries polluting the converted PCBoard directory.
  27.  
  28.  
  29. HOW DO I USE IT?
  30.  
  31. Using CAT2DIR is extremely simple.  First, PLEASE make sure you're
  32. using a current version of CATDISK!  The current version as of this
  33. writing is V6.31.  If your version is earlier than this, you'll need
  34. to download CDISK631.ZIP from your friendly neighborhood BBS (see
  35. the end of this file for the number of a GREAT one!)  Upgrading your
  36. databases is very simple and very necessary, since earlier versions
  37. of CATDISK used a different file structure.  Be sure to carefully
  38. follow the upgrading instructions in file "READ.ME!".
  39.  
  40. Assuming you have current files, you should next decide whether you
  41. want CAT2DIR to create the zero-byte files for you.  If so, you need
  42. to decide where they'll be written, and make sure that subdirectory
  43. exists and is empty.
  44.  
  45. With those two conditions met, simply invoke CAT2DIR as follows:
  46.  
  47.   CAT2DIR InFileName OutFileName [/FILES FileDirectory]
  48.  
  49.   where InFileName    is the name (including path, if needed) of a
  50.                       CATDISK archive (.DTA) file, and
  51.         OutFileName   is the name (including path, if needed) of a
  52.                       file to which you'd like the PCBoard-format
  53.                       directory written.
  54.         FileDirectory is the optional name of a directory to which
  55.                       zero-byte dummy files for PCBoard should be
  56.                       written.  If you don't wish to write dummy
  57.                       files, omit this.
  58.  
  59. Note that it's perfectly OK if the output file already exists.  If it
  60. does, CAT2DIR will ask you whether you'd like to append to the file,
  61. overwrite it, or simply change your mind and do nothing.  Since it's a
  62. good possibility that a SYSOP might want to copy several CATDISK
  63. databases into a single PCBoard directory, the append function should
  64. prove especially useful.
  65.  
  66. Note also that if asked to create dummy files, CAT2DIR will run
  67. considerably more slowly.  Just how much more slowly it runs will
  68. depend largely on your disk drive (and cache, if any).
  69.  
  70. As it runs, CAT2DIR will keep you posted on its progress.  For each
  71. CATDISK record it encounters in the input file, it will display a small
  72. marker character on the screen.  These have the following meanings:
  73.  
  74.    +  means "Record copied, no problem."
  75.    -  means "Record skipped because it wasn't an archive file."
  76.    ?  means "Record skipped because one or more fields is bogus."
  77.  
  78. At the completion of each run. CAT2DIR will also give you counts of
  79. records copied and skipped, as well as how many bogus records it was
  80. unable to process.
  81.  
  82. Should a serious error occur during the run, CAT2DIR will terminate
  83. and inform you of the problem.  However, all records converted prior
  84. to the error will have been converted successfully, and the program
  85. will close all files and exit gracefully to the best of its ability.
  86. You may also abort CAT2DIR at any time using CTRL-BREAK, with complete
  87. confidence that all records up to the break point have been dealt with
  88. correctly.
  89.  
  90.  
  91. REVISION HISTORY
  92.  
  93. Version  Date      Description
  94. -------  --------  --------------------------------------------------
  95. 1.00ß    09/01/92  First beta release.
  96. 1.10     09/03/92  First production release.  Input record validation
  97.                    code improved & tightened.  Documentation revised
  98.                    to reflect changes.
  99. 1.15     09/03/92  CATDISK database record structure changed from
  100.                    V6.15 to V6.31.  No other changes this version.
  101. 2.00     09/07/92  Added capability to create zero-byte dummy files
  102.                    automatically for each entry.  Documentation was
  103.                    revised slightly.
  104.  
  105.  
  106. WHO'S RESPONSIBLE FOR THIS OUTRAGE?
  107.  
  108. CAT2DIR was written by K. Scott Johnson, and is copyrighted material. It
  109. is released as freeware.  This means that you owe the author nothing in
  110. exchange for the use of the program.  You may distribute it freely by
  111. any means so long as the author's name and copyright notice remain intact,
  112. and so long as this documentation is distributed with each copy.
  113.  
  114. If you have any comments or suggestions on how to improve this program,
  115. I'd love to hear from you.  I can be contacted at any of these addresses:
  116.  
  117.                 Scott Johnson
  118.                 4205 Long Key Lane #1526
  119.                 Winter Park, FL 32792
  120.  
  121.                 e-mail: ksj7i@virginia.edu
  122.                         bbs-ksj@jwt.UUCP
  123.  
  124.                 BBS:    The Freeware Hall Of Fame (Rey Barry, SYSOP)
  125.                         (804) 293-4710 (USR DS, 2400-14.4K bps)
  126.